package cn.iocoder.yudao.module.reading.service.plan;

import cn.iocoder.yudao.module.reading.controller.app.plan.vo.ReadingPlanCreateReqVO;
import cn.iocoder.yudao.module.reading.dal.dataobject.plan.ReadingPlanDO;

import java.util.List;

/**
 * 阅读计划 Service 接口
 *
 * @author 芋道源码
 */
public interface ReadingPlanService {

    /**
     * 创建阅读计划
     *
     * @param userId      用户ID
     * @param createReqVO 创建信息
     * @return 计划ID
     */
    Long createReadingPlan(Long userId, ReadingPlanCreateReqVO createReqVO);

    /**
     * 获得阅读计划
     *
     * @param id 编号
     * @return 阅读计划
     */
    ReadingPlanDO getReadingPlan(Long id);

    /**
     * 获得用户的阅读计划列表
     *
     * @param userId 用户ID
     * @param status 计划状态（可选）
     * @return 计划列表
     */
    List<ReadingPlanDO> getReadingPlansByUserId(Long userId, String status);

    /**
     * 更新计划进度
     *
     * @param planId 计划ID
     */
    void updatePlanProgress(Long planId);

    /**
     * 暂停计划
     *
     * @param planId 计划ID
     */
    void pausePlan(Long planId);

    /**
     * 恢复计划
     *
     * @param planId 计划ID
     */
    void resumePlan(Long planId);

    /**
     * 完成计划
     *
     * @param planId 计划ID
     */
    void completePlan(Long planId);

    /**
     * 取消计划（更新状态为已取消）
     *
     * @param planId 计划ID
     */
    void cancelPlan(Long planId);

    /**
     * 删除计划（物理删除）
     *
     * @param planId 计划ID
     */
    void deletePlan(Long planId);

}
